event { purge { storage-limit bytes | time-limit seconds } | push-interval value | push-trigger space-usage-percent trigger_percentage | remove-file-after-transfer | transfer-mode { pull [ module-only ] | push primary { encrypted-url encrypted_url | url url } [ max-files files ] [ module-only ] [ secondary { encrypted-secondary-url url | secondary-url url } ] [ via local-context ] } | use-harddisk }
|
•
|
purge: Not enabled.
|
|
•
|
push-interval: 60 seconds
|
|
•
|
push-trigger: 80 percent
|
|
•
|
remove-file-after-transfer: Disabled
|
|
•
|
transfer mode: Push
|
|
•
|
use-harddisk: Disabled
|
|
•
|
purge: Disables the deleting of record files on the hard disk based on a storage limit or a time limit.
|
|
•
|
remove-file-after-transfer: Retains a copy of the file even after it has been pushed or pulled to another server.
|
|
•
|
use-harddisk: Disables data storage on the system’s hard disk.
|
storage-limit bytes: Specifies that event records are to be deleted from the hard drive upon reaching a storage limit defined in bytes. bytes must be an integer value from 10485760 to 146800640.
time-limit seconds: Specifies that event records are to be deleted from the hard drive upon reaching a time limit defined in seconds. seconds must be an integer value from 600 to 2592000.
push-interval value
Specifies the transfer interval (in seconds) when event files will be pushed to an external file server. value must be an integer from 30 through 3600.
push-trigger space-usage-percent trigger_percentage
Specifies the disk space utilization percentage threshold at which an automatic push is triggered and files are transferred to the external server. trigger_percentage must be an integer from 10 through 80.
transfer-mode { pull [ module-only ] | push primary { encrypted-url encrypted_url | url url } [ max-files files ] [ module-only ] [ secondary { encrypted-secondary-url url | secondary-url url } ] [ via local-context ] }
|
•
|
pull: Specifies that the destination server will pull the event files.
|
|
•
|
push: Specifies that the system will push event files to the destination server. This is the default mode.
|
|
•
|
primary encrypted-url encrypted_url: Specifies the primary URL location to which the system pushes the files in encrypted format. encrypted_url must be an alphanumeric string of 1 through 8192 characters.
|
|
•
|
primary url url: Specifies the primary URL location to which the system pushes the event files. url must be an alphanumeric string of 1 through 1024 characters in the format: //user:password@host:[port]/direct.
|
|
•
|
max-files number: Specifies the maximum number of files that can be transferred per push. number must be an integer from 4 to 4000.
|
|
•
|
module-only: Specifies that the transfer of event records is to be applied only to the module type for which the configuration was originally created. If this option is not enabled, the transfer will occur for all record types.
|
|
•
|
secondary encrypted-secondary-url url: Specifies the secondary URL location to which the system pushes the files in encrypted format. url must be an alphanumeric string of 1 through 8192 characters.
|
|
•
|
secondary-url url: Specifies the secondary URL location to which the system pushes the event files. url must be an alphanumeric string of 1 through 1024 characters in the format: //user:password@host:[port]/direct
|
|
•
|
via local-context: Specifies that the local context, and, subsequently, the SPIO management ports, will be used to pull or push event files from/to the event server.
|
The event use-harddisk command can be run only in a context where CDRMOD is running. Configuring in any other context will result in failure with the message “Failure: Please Check if CDRMOD is running in this context or not.”
file [ compression { gzip | none } ] [ current-prefix string ] [ delete-timeout seconds ] [ directory directory_name ] [ exclude-checksum-record ] [ field-separator { hyphen | omit | underscore } ] [ file-sequence-number rulebase-seq-num ] [ headers ] [ name file_name ] [ reset-indicator ] [ rotation [ num-records number | time seconds | volume bytes ] ] [ sequence-number { length length | omit | padded | padded-six-length | unpadded } ] [ storage-limit limit ] [ time-stamp { expanded-format | rotated-format | unix-format } ] [ trailing-text string ] [ trap-on-file-delete ] [ xor-final-record ] +
|
•
|
gzip: Enables GNU zip compression of the event file at approximately 10:1 ratio.
|
|
•
|
none: Disables Gzip compression.
|
current-prefix string
Specifies a string to add to the beginning of the event file that is currently being used to store records. string must be an alphanumeric string of 1 through 31 characters. Default: curr
delete-timeout seconds
Specifies a time period, in seconds, after which event files are deleted. By default, files are never deleted. seconds must be an integer from 3600 through 31536000. Default: Disabled
directory directory_name
Specifies a subdirectory in the default directory in which to store event files. directory_name must be an alphanumeric string of 1 through 191 characters. Default: /records/event
|
•
|
hyphen: Specifies the field separator as a “-” (hyphen) symbol between two fields.
|
|
•
|
omit: Removes or omits the field separator between two fields.
|
|
•
|
underscore: Specifies the field separator as an “_” (underscore) symbol between two fields.
|
name file_name
Specifies a string to be used as the base file name for event files. file_name must be an alphanumeric string of 1 through 31 characters. The file name format is as follows:
base_sequencenum_timestamp Default: event
|
•
|
base: Specifies type of record in file or contains the operator-specified string. Default: event
|
|
•
|
sequencenum: This is a 5-digit sequence number to detect the missing file sequence. It is unique among all event files on the system.
|
|
•
|
timestamp: Adds a file creation timestamp (UTC time) in MMDDYYYYHHMMSS format.
|
|
•
|
The sequence number (see sequence-number keyword) has rolled over to zero.
|
|
•
|
num-records number: Specifies the maximum number of records that should be added to an event file. When the number of records in the file reaches this value, the file is complete. number must be an integer 100 through 10240. Default: 1024
|
|
•
|
time seconds: Specifies the period of time to wait (in seconds) before closing the current event file and creating a new one. seconds must be an integer from 30 through 86400. Default: 3600
|
|
•
|
volume bytes: Specifies the maximum size of the event file (in bytes) before closing it and creating a new one. bytes must be an integer from 51200 through 62914560. Note that a higher setting may improve the compression ratio when the compression keyword is set to gzip. Default: 102400
|
|
•
|
length length: Includes the sequence number with the specified length. length must be the file sequence number length with preceding zeroes in the file name, and must be an integer from 1 through 9.
|
|
•
|
omit: Excludes the sequence number from the file name.
|
|
•
|
padded: Includes the padded sequence number with preceding zeros in the file name. This is the default setting.
|
|
•
|
padded-six-length: Includes the padded sequence number with six preceding zeros in the file name.
|
|
•
|
unpadded: Includes the unpadded sequence number in the file name.
|
Default: padded
storage-limit limit
limit must be an integer from 10485760 through 536870912. Default: 33554432
|
•
|
expanded-format: Specifies the UTC (Universal Time Coordinated) MMDDYYYYHHMMSS format.
|
|
•
|
rotated-format: Specifies the time stamp format to YYYYMMDDHHMMSS format.
|
|
•
|
unix-format: Specifies the UNIX format of x.y, where x is the number of seconds since 1/1/1970 and y is the fractional portion of the current second that has elapsed.
|
trailing-text string
Specifies inserting an exclusive OR (XOR) checksum (instead of a CRC checksum) into the event file header if the exclude-checksum-record is left at its default setting. Default: Disabled
